Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(changelog)!: add postprocessors #155

Merged
merged 7 commits into from
Jun 10, 2023
Merged

feat(changelog)!: add postprocessors #155

merged 7 commits into from
Jun 10, 2023

Conversation

PSeitz
Copy link
Contributor

@PSeitz PSeitz commented Apr 13, 2023 •
edited
Loading

Description

Allow same transformations on the final output as with the git commit preprocessor.
This will enable things like replacing usernames with github usernames #132

How Has This Been Tested?

tested locally

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@PSeitz PSeitz requested a review from orhun as a code owner April 13, 2023 14:12
@orhun
Copy link
Owner

orhun commented Apr 13, 2023

Hello, thanks for the contribution! 🐻

Can you maybe provide an example about this feature in the documentation? It is not clear what changes are made from the code.

@orhun
Copy link
Owner

orhun commented Apr 13, 2023 •
edited
Loading

Also, isn't this a library-wise breaking change since CommitPreprocessor is renamed as TextProcessor?

@PSeitz
Copy link
Contributor Author

PSeitz commented Apr 19, 2023

Also, isn't this a library-wise breaking change since CommitPreprocessor is renamed as TextProcessor?

Yes, I didn't know it's also used as a library.

I updated the docs with the new feature.

@PSeitz
feat: add postprocessors to changelog
e5fd555 
This will enable things like replacing usernames with github usernames orhun#132
@PSeitz
Copy link
Contributor Author

PSeitz commented Apr 20, 2023

Fixed the commit message by squashing

@PSeitz
Copy link
Contributor Author

PSeitz commented Apr 20, 2023

The test failure is unrelated

@PSeitz PSeitz requested a review from orhun April 25, 2023 00:57
orhun
orhun requested changes Apr 26, 2023
View reviewed changes
Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had some comments / suggestions.

website/docs/configuration.md Outdated Show resolved Hide resolved
website/docs/configuration.md Outdated Show resolved Hide resolved
git-cliff-core/src/changelog.rs Outdated Show resolved Hide resolved
git-cliff-core/src/config.rs Outdated Show resolved Hide resolved
@orhun
Copy link
Owner

orhun commented May 3, 2023

Can you also check out #165 and pre-empt your opinion before this PR is merged?

@codecov-commenter
Copy link

Codecov Report

Patch coverage: 70.59% and project coverage change: +0.66 🎉

Comparison is base (263cb6c) 43.66% compared to head (6b060f8) 44.32%.

❗ Current head 6b060f8 differs from pull request most recent head 38c9e8d. Consider uploading reports for the commit 38c9e8d to get more accurate results

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #155      +/-   ##
==========================================
+ Coverage   43.66%   44.32%   +0.66%     
==========================================
  Files          12       12              
  Lines         575      580       +5     
==========================================
+ Hits          251      257       +6     
+ Misses        324      323       -1
Flag Coverage Δ
unit-tests 44.32% <70.59%> (+0.66%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
git-cliff-core/src/config.rs 41.67% <50.00%> (+4.17%) ⬆️
git-cliff-core/src/changelog.rs 55.67% <83.34%> (+1.21%) ⬆️
git-cliff-core/src/commit.rs 95.53% <100.00%> (+3.98%) ⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@orhun orhun changed the title feat: add postprocessors to changelog feat(changelog)!: add postprocessors Jun 10, 2023
@orhun orhun merged commit 5dc5fb7 into orhun:main Jun 10, 2023
@welcome
Copy link

welcome bot commented Jun 10, 2023

Congrats on merging your first pull request! ⛰️

@ZhongRuoyu ZhongRuoyu mentioned this pull request Aug 31, 2023
Closed
@nekofar nekofar mentioned this pull request Sep 2, 2023
Closed
@BrewTestBot BrewTestBot mentioned this pull request Sep 2, 2023
Closed
@friday friday mentioned this pull request Oct 21, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@orhun orhun orhun approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@PSeitz @orhun @codecov-commenter